// Copyright 2020 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ------------------------------------------------------------------
// Modification history:
// feature: Support the reader to filter again through the writer's filtering results
// feature: develop dispatcher
// ------------------------------------------------------------------

#ifndef INCLUDE_EDDS_RTPS_INTERFACES_IREADERDATAFILTER_HPP_
#define INCLUDE_EDDS_RTPS_INTERFACES_IREADERDATAFILTER_HPP_

#include <history/CacheChange.h>
#include <edds/rtps/common/Guid.h>
#include <xmlparser/attributes/XMLRTPSParticipantAllocationAttributes.hpp>

namespace evbs {
namespace ertps {
namespace rtps {

/**
 * Abstract class IReaderDataFilter that acts as virtual interface for data filters in ReaderProxy.
 * @ingroup RTPS_MODULE
 */
class IReaderDataFilter {
 public:
    /**
     * This method checks whether a CacheChange_t is relevant for the specified reader
     * This callback should return always the same result given the same arguments
     * @param change The CacheChange_t to be evaluated
     * @param reader_guid remote reader GUID_t
     * @return true if relevant, false otherwise.
     */
    virtual ~IReaderDataFilter() = default;
    virtual bool is_relevant(const vbs::common::CacheChange_t& change,
                             const ertps::rtps::GUID_t& reader_guid) const = 0;
    /**
     * This method checks whether a CacheChange_t is relevant for the specified reader
     * This callback should return always the same result given the same arguments
     * @param change The CacheChange_t to be evaluated
     * @param filter_property reader filter property
     * @param reader_guid remote reader GUID_t
     * @return true if relevant, false otherwise.
     */
    virtual bool check_filter_signature(vbs::common::CacheChange_t& change,
                                        const vbsutil::xmlparser::ContentFilterProperty& filter_property,
                                        const evbs::ertps::rtps::GUID_t& reader_guid) {
        (void)change;
        (void)filter_property;
        (void)reader_guid;
        return true;
    };
};

} /* namespace rtps */
} /* namespace ertps */
} /* namespace evbs */

#endif  // INCLUDE_EDDS_RTPS_INTERFACES_IREADERDATAFILTER_HPP_
